v0.7.7: axum v0.7.7

Compare Source

• change: Remove manual tables of content from the documentation, since
  rustdoc now generates tables of content in the sidebar (#​2921)

v0.7.6: axum - v0.7.6

Compare Source

• change: Avoid cloning Arc during deserialization of Path
• added: axum::serve::Serve::tcp_nodelay and axum::serve::WithGracefulShutdown::tcp_nodelay (#​2653)
• added: Router::has_routes function (#​2790)
• change: Update tokio-tungstenite to 0.23 (#​2841)
• added: Serve::local_addr and WithGracefulShutdown::local_addr functions (#​2881)

v0.7.5: axum - v0.7.5

Compare Source

• fixed: Fixed layers being cloned when calling axum::serve directly with
  a Router or MethodRouter (#​2586)
• fixed: h2 is no longer pulled as a dependency unless the http2 feature
  is enabled (#​2605)

v0.7.4: axum - v0.7.4

Compare Source

• fixed: Fix performance regression present since axum 0.7.0 (#​2483)
• fixed: Improve debug_handler on tuple response types (#​2201)
• added: Add must_use attribute to Serve and WithGracefulShutdown (#​2484)
• added: Re-export axum_core::body::BodyDataStream from axum

v0.7.3: axum - v0.7.3

Compare Source

• added: Body implements From<()> now (#​2411)
• change: Update version of multer used internally for multipart (#​2433)
• change: Update tokio-tungstenite to 0.21 (#​2435)
• added: Enable tracing feature by default (#​2460)
• added: Support graceful shutdown on serve (#​2398)
• added: RouterIntoService implements Clone (#​2456)

v0.7.2: axum - v0.7.2

Compare Source

• added: Add axum::body::to_bytes (#​2373)
• fixed: Gracefully handle accept errors in serve (#​2400)

v0.7.1: axum - v0.7.1

Compare Source

• fix: Fix readme.

v0.7.0: axum - v0.7.0

Compare Source

• breaking: Update public dependencies. axum now requires
  • hyper 1.0
  • http 1.0
  • http-body 1.0
• breaking: axum now requires tower-http 0.5
• breaking: Remove deprecated WebSocketUpgrade::max_send_queue
• breaking: The following types/traits are no longer generic over the request body
  (i.e. the B type param has been removed) (#​1751 and #​1789):
  • FromRequestParts
  • FromRequest
  • HandlerService
  • HandlerWithoutStateExt
  • Handler
  • LayeredFuture
  • Layered
  • MethodRouter
  • Next
  • RequestExt
  • RouteFuture
  • Route
  • Router
• breaking: axum no longer re-exports hyper::Body as that type is removed
  in hyper 1.0. Instead axum has its own body type at axum::body::Body (#​1751)
• breaking: extract::BodyStream has been removed as body::Body
  implements Stream and FromRequest directly (#​1751)
• breaking: Change sse::Event::json_data to use axum_core::Error as its error type (#​1762)
• breaking: Rename DefaultOnFailedUpdgrade to DefaultOnFailedUpgrade (#​1664)
• breaking: Rename OnFailedUpdgrade to OnFailedUpgrade (#​1664)
• breaking: TypedHeader has been move to axum-extra (#​1850)
• breaking: Removed re-exports of Empty and Full. Use
  axum::body::Body::empty and axum::body::Body::from respectively (#​1789)
• breaking: The response returned by IntoResponse::into_response must use
  axum::body::Body as the body type. axum::response::Response does this
  (#​1789)
• breaking: Removed the BoxBody type alias and its box_body
  constructor. Use axum::body::Body::new instead (#​1789)
• breaking: Remove RawBody extractor. axum::body::Body implements FromRequest directly (#​1789)
• breaking: The following types from http-body no longer implement IntoResponse:
  • Full, use Body::from instead
  • Empty, use Body::empty instead
  • BoxBody, use Body::new instead
  • UnsyncBoxBody, use Body::new instead
  • MapData, use Body::new instead
  • MapErr, use Body::new instead
• added: Add axum::extract::Request type alias where the body is axum::body::Body (#​1789)
• added: Add Router::as_service and Router::into_service to workaround
  type inference issues when calling ServiceExt methods on a Router (#​1835)
• breaking: Removed axum::Server as it was removed in hyper 1.0. Instead
  use axum::serve(listener, service) or hyper/hyper-util for more configuration options (#​1868)
• breaking: Only inherit fallbacks for routers nested with Router::nest.
  Routers nested with Router::nest_service will no longer inherit fallbacks (#​1956)
• fixed: Don't remove the Sec-WebSocket-Key header in WebSocketUpgrade (#​1972)
• added: Add axum::extract::Query::try_from_uri (#​2058)
• added: Implement IntoResponse for Box<str> and Box<[u8]> ([#​2035])
• breaking: Simplify MethodFilter. It no longer uses bitflags (#​2073)
• fixed: Fix bugs around merging routers with nested fallbacks (#​2096)
• fixed: Fix .source() of composite rejections (#​2030)
• fixed: Allow unreachable code in #[debug_handler] (#​2014)
• change: axum's MSRV is now 1.66 (#​1882)
• added: Implement IntoResponse for (R,) where R: IntoResponse (#​2143)
• changed: For SSE, add space between field and value for compatibility (#​2149)
• added: Add NestedPath extractor (#​1924)
• added: Add handle_error function to existing ServiceExt trait (#​2235)
• breaking: impl<T> IntoResponse(Parts) for Extension<T> now requires
  T: Clone, as that is required by the http crate (#​1882)
• added: Add axum::Json::from_bytes (#​2244)
• added: Implement FromRequestParts for http::request::Parts (#​2328)
• added: Implement FromRequestParts for http::Extensions (#​2328)
• fixed: Clearly document applying DefaultBodyLimit to individual routes (#​2157)

v0.6.20: axum - v0.6.20

Compare Source

• added: WebSocketUpgrade::write_buffer_size and WebSocketUpgrade::max_write_buffer_size
• changed: Deprecate WebSocketUpgrade::max_send_queue
• change: Update tokio-tungstenite to 0.20
• added: Implement Handler for T: IntoResponse (#​2140)

v0.6.19: axum - v0.6.19

Compare Source

• added: Add axum::extract::Query::try_from_uri (#​2058)
• added: Implement IntoResponse for Box<str> and Box<[u8]> (#​2035)
• fixed: Fix bugs around merging routers with nested fallbacks (#​2096)
• fixed: Fix .source() of composite rejections (#​2030)
• fixed: Allow unreachable code in #[debug_handler] (#​2014)
• change: Update tokio-tungstenite to 0.19 (#​2021)
• change: axum's MSRV is now 1.63 (#​2021)

v0.6.18: axum - v0.6.18

Compare Source

• fixed: Don't remove the Sec-WebSocket-Key header in WebSocketUpgrade (#​1972)

v0.6.17: axum - v0.6.17

Compare Source

• fixed: Fix fallbacks causing a panic on CONNECT requests (#​1958)

v0.6.16: axum - v0.6.16

Compare Source

• fixed: Don't allow extracting MatchedPath in fallbacks (#​1934)
• fixed: Fix panic if Router with something nested at / was used as a fallback (#​1934)
• added: Document that Router::new().fallback(...) isn't optimal (#​1940)

v0.6.15: axum - v0.6.15

Compare Source

• fixed: Removed additional leftover debug messages (#​1927)

v0.6.14: axum - v0.6.14

Compare Source

• fixed: Removed leftover "path_router hit" debug message (#​1925)

v0.6.13: axum - v0.6.13

Compare Source

• added: Log rejections from built-in extractors with the
  axum::rejection=trace target (#​1890)
• fixed: Fixed performance regression with Router::nest introduced in
  0.6.0. nest now flattens the routes which performs better (#​1711)
• fixed: Extracting MatchedPath in nested handlers now gives the full
  matched path, including the nested path (#​1711)
• added: Implement Deref and DerefMut for built-in extractors (#​1922)

v0.6.12: axum - v0.6.12

Compare Source

• added: Implement IntoResponse for MultipartError (#​1861)
• fixed: More clearly document what wildcards matches (#​1873)

v0.6.11: axum - v0.6.11

Compare Source

• fixed: Don't require S: Debug for impl Debug for Router<S> (#​1836)
• fixed: Clone state a bit less when handling requests (#​1837)
• fixed: Unpin itoa dependency (#​1815)

v0.6.10: axum - v0.6.10

Compare Source

• fixed: Add #[must_use] attributes to types that do nothing unless used (#​1809)
• fixed: Gracefully handle missing headers in the TypedHeader extractor (#​1810)
• fixed: Fix routing issues when loading a Router via a dynamic library (#​1806)

v0.6.9: axum - v0.6.9

Compare Source

• changed: Update to tower-http 0.4. axum is still compatible with tower-http 0.3 (#​1783)

v0.6.8: axum - v0.6.8

Compare Source

• fixed: Fix Allow missing from routers with middleware (#​1773)
• added: Add KeepAlive::event for customizing the event sent for SSE keep alive (#​1729)

v0.6.7: axum - v0.6.7

Compare Source

• added: Add FormRejection::FailedToDeserializeFormBody which is returned
  if the request body couldn't be deserialized into the target type, as opposed
  to FailedToDeserializeForm which is only for query parameters (#​1683)
• added: Add MockConnectInfo for setting ConnectInfo during tests (#​1767)

v0.6.6: axum - v0.6.6

Compare Source

• fixed: Enable passing MethodRouter to Router::fallback (#​1730)

v0.6.5: axum - v0.6.5

Compare Source

• fixed: Fix #[debug_handler] sometimes giving wrong borrow related suggestions (#​1710)
• Document gotchas related to using impl IntoResponse as the return type from handler functions (#​1736)

v0.6.4: axum - v0.6.4

Compare Source

• Depend on axum-macros 0.3.2

v0.6.3: axum - v0.6.3

Compare Source

• added: Implement IntoResponse for &'static [u8; N] and [u8; N] (#​1690)
• fixed: Make Path support types using serde::Deserializer::deserialize_any (#​1693)
• added: Add RawPathParams (#​1713)
• added: Implement Clone and Service for axum::middleware::Next (#​1712)
• fixed: Document required tokio features to run "Hello, World!" example (#​1715)

v0.6.2: axum - v0.6.2

Compare Source

• added: Add body_text and status methods to built-in rejections (#​1612)
• added: Enable the runtime feature of hyper when using tokio (#​1671)

v0.6.1: axum - v0.6.1

Compare Source

• added: Expand the docs for Router::with_state (#​1580)

v0.6.0: axum - v0.6.0

Compare Source

Routing

• fixed: Nested routers are now allowed to have fallbacks (#​1521):

  let api_router = Router::new()
      .route("/users", get(|| { ... }))
      .fallback(api_fallback);
  
  let app = Router::new()
      // this would panic in 0.5 but in 0.6 it just works
      //
      // requests starting with `/api` but not handled by `api_router`
      // will go to `/api_fallback`
      .nest("/api", api_router);

  The outer router's fallback will still apply if a nested router doesn't have
  its own fallback:

  // this time without a fallback
  let api_router = Router::new().route("/users", get(|| { ... }));
  
  let app = Router::new()
      .nest("/api", api_router)
      // `api_fallback` will inherit this fallback
      .fallback(app_fallback);

• breaking: The request /foo/ no longer matches /foo/*rest. If you want
  to match /foo/ you have to add a route specifically for that (#​1086)

  For example:

  use axum::{Router, routing::get, extract::Path};
  
  let app = Router::new()
      // this will match `/foo/bar/baz`
      .route("/foo/*rest", get(handler))
      // this will match `/foo/`
      .route("/foo/", get(handler))
      // if you want `/foo` to match you must also add an explicit route for it
      .route("/foo", get(handler));
  
  async fn handler(
      // use an `Option` because `/foo/` and `/foo` don't have any path params
      params: Option<Path<String>>,
  ) {}

• breaking: Path params for wildcard routes no longer include the prefix
  /. e.g. /foo.js will match /*filepath with a value of foo.js, not
  /foo.js (#​1086)

  For example:

  use axum::{Router, routing::get, extract::Path};
  
  let app = Router::new().route("/foo/*rest", get(handler));
  
  async fn handler(
      Path(params): Path<String>,
  ) {
      // for the request `/foo/bar/baz` the value of `params` will be `bar/baz`
      //
      // on 0.5 it would be `/bar/baz`
  }

• fixed: Routes like /foo and /*rest are no longer considered
  overlapping. /foo will take priority (#​1086)

  For example:

  use axum::{Router, routing::get};
  
  let app = Router::new()
      // this used to not be allowed but now just works
      .route("/foo/*rest", get(foo))
      .route("/foo/bar", get(bar));
  
  async fn foo() {}
  
  async fn bar() {}

• breaking: Automatic trailing slash redirects have been removed.
  Previously if you added a route for /foo, axum would redirect calls to
  /foo/ to /foo (or vice versa for /foo/):

  use axum::{Router, routing::get};
  
  let app = Router::new()
      // a request to `GET /foo/` will now get `404 Not Found`
      // whereas in 0.5 axum would redirect to `/foo`
      //
      // same goes the other way if you had the route `/foo/`
      // axum will no longer redirect from `/foo` to `/foo/`
      .route("/foo", get(handler));
  
  async fn handler() {}

  Either explicitly add routes for /foo and /foo/ or use
  axum_extra::routing::RouterExt::route_with_tsr if you want the old behavior
  (#​1119)

• breaking: Router::fallback now only accepts Handlers (similarly to
  what get, post, etc. accept). Use the new Router::fallback_service for
  setting any Service as the fallback (#​1155)

  This fallback on 0.5:

  use axum::{Router, handler::Handler};
  
  let app = Router::new().fallback(fallback.into_service());
  
  async fn fallback() {}

  Becomes this in 0.6

  use axum::Router;
  
  let app = Router::new().fallback(fallback);
  
  async fn fallback() {}

• changed: Router::nest now only accepts Routers, the general-purpose
  Service nesting method has been renamed to nest_service (#​1368)

• breaking: Allow Error: Into<Infallible> for Route::{layer, route_layer} (#​924)

• breaking: MethodRouter now panics on overlapping routes (#​1102)

• breaking: Router::route now only accepts MethodRouters created with
  get, post, etc. Use the new Router::route_service for routing to
  any Services (#​1155)

• breaking: Adding a .route_layer onto a Router or MethodRouter
  without any routes will now result in a panic. Previously, this just did
  nothing. #​1327

• breaking: RouterService has been removed since Router now implements
  Service when the state is (). Use Router::with_state to provide the
  state and get a Router<()>. Note that RouterService only existed in the
  pre-releases, not 0.5 (#​1552)

Extractors

• added: Added new type safe State extractor. This can be used with
  Router::with_state and gives compile errors for missing states, whereas
  Extension would result in runtime errors (#​1155)

  We recommend migrating from Extension to State for sharing application state since that is more type
  safe and faster. That is done by using Router::with_state and State.

  This setup in 0.5

  use axum::{routing::get, Extension, Router};
  
  let app = Router::new()
      .route("/", get(handler))
      .layer(Extension(AppState {}));
  
  async fn handler(Extension(app_state): Extension<AppState>) {}
  
  #[derive(Clone)]
  struct AppState {}

  Becomes this in 0.6 using State:

  use axum::{routing::get, extract::State, Router};
  
  let app = Router::new()
      .route("/", get(handler))
      .with_state(AppState {});
  
  async fn handler(State(app_state): State<AppState>) {}
  
  #[derive(Clone)]
  struct AppState {}

  If you have multiple extensions, you can use fields on AppState and implement
  FromRef:

  use axum::{extract::{State, FromRef}, routing::get, Router};
  
  let state = AppState {
      client: HttpClient {},
      database: Database {},
  };
  
  let app = Router::new().route("/", get(handler)).with_state(state);
  
  async fn handler(
      State(client): State<HttpClient>,
      State(database): State<Database>,
  ) {}
  
  // the derive requires enabling the "macros" feature
  #[derive(Clone, FromRef)]
  struct AppState {
      client: HttpClient,
      database: Database,
  }
  
  #[derive(Clone)]
  struct HttpClient {}
  
  #[derive(Clone)]
  struct Database {}

• breaking: It is now only possible for one extractor per handler to consume
  the request body. In 0.5 doing so would result in runtime errors but in 0.6 it
  is a compile error (#​1272)

  axum enforces this by only allowing the last extractor to consume the
  request.

  For example:

  use axum::{Json, http::HeaderMap};
  
  // This wont compile on 0.6 because both `Json` and `String` need to consume
  // the request body. You can use either `Json` or `String`, but not both.
  async fn handler_1(
      json: Json<serde_json::Value>,
      string: String,
  ) {}
  
  // This won't work either since `Json` is not the last extractor.
  async fn handler_2(
      json: Json<serde_json::Value>,
      headers: HeaderMap,
  ) {}
  
  // This works!
  async fn handler_3(
      headers: HeaderMap,
      json: Json<serde_json::Value>,
  ) {}

  This is done by reworking the FromRequest trait and introducing a new
  FromRequestParts trait.

  If your extractor needs to consume the request body then you should implement
  FromRequest, otherwise implement FromRequestParts.

  This extractor in 0.5:

  struct MyExtractor { /* ... */ }
  
  #[async_trait]
  impl<B> FromRequest<B> for MyExtractor
  where
      B: Send,
  {
      type Rejection = StatusCode;
  
      async fn from_request(req: &mut RequestParts<B>) -> Result<Self, Self::Rejection> {
          // ...
      }
  }

  Becomes this in 0.6:

  use axum::{
      extract::{FromRequest, FromRequestParts},
      http::{StatusCode, Request, request::Parts},
      async_trait,
  };
  
  struct MyExtractor { /* ... */ }
  
  // implement `FromRequestParts` if you don't need to consume the request body
  #[async_trait]
  impl<S> FromRequestParts<S> for MyExtractor
  where
      S: Send + Sync,
  {
      type Rejection = StatusCode;
  
      async fn from_request_parts(parts: &mut Parts, state: &S) -> Result<Self, Self::Rejection> {
          // ...
      }
  }
  
  // implement `FromRequest` if you do need to consume the request body
  #[async_trait]
  impl<S, B> FromRequest<S, B> for MyExtractor
  where
      S: Send + Sync,
      B: Send + 'static,
  {
      type Rejection = StatusCode;
  
      async fn from_request(req: Request<B>, state: &S) -> Result<Self, Self::Rejection> {
          // ...
      }
  }

  For an example of how to write an extractor that accepts different
  Content-Types see the [parse-body-based-on-content-type][parse-body-based-on-content-type] example.

• added: FromRequest and FromRequestParts derive macro re-exports from
  [axum-macros][axum-macros] behind the macros feature (#​1352)

• added: Add RequestExt and RequestPartsExt which adds convenience
  methods for running extractors to http::Request and http::request::Parts (#​1301)

• added: JsonRejection now displays the path at which a deserialization
  error occurred (#​1371)

• added: Add extract::RawForm for accessing raw urlencoded query bytes or request body (#​1487)

• fixed: Used 400 Bad Request for FailedToDeserializeQueryString
  rejections, instead of 422 Unprocessable Entity (#​1387)

• changed: The inner error of a JsonRejection is now
  serde_path_to_error::Error<serde_json::Error>. Previously it was
  serde_json::Error (#​1371)

• changed: The default body limit now applies to the Multipart extractor (#​1420)

• breaking: ContentLengthLimit has been removed. Use DefaultBodyLimit instead (#​1400)

• breaking: RequestParts has been removed as part of the FromRequest
  rework (#​1272)

• breaking: BodyAlreadyExtracted has been removed (#​1272)

• breaking: The following types or traits have a new S type param
  which represents the state (#​1155):

  • Router, defaults to ()
  • MethodRouter, defaults to ()
  • FromRequest, no default
  • Handler, no default

• breaking: MatchedPath can now no longer be extracted in middleware for
  nested routes. In previous versions it returned invalid data when extracted
  from a middleware applied to a nested router. MatchedPath can still be
  extracted from handlers and middleware that aren't on nested routers (#​1462)

• breaking: Rename FormRejection::FailedToDeserializeQueryString to
  FormRejection::FailedToDeserializeForm (#​1496)

Middleware

• added: Support running extractors on middleware::from_fn functions (#​1088)
• added: Add middleware::from_fn_with_state to enable running extractors that require
  state (#​1342)
• added: Add middleware::from_extractor_with_state (#​1396)
• added: Add map_request, map_request_with_state for transforming the
  request with an async function (#​1408)
• added: Add map_response, map_response_with_state for transforming the
  response with an async function (#​1414)
• added: Support any middleware response that implements IntoResponse (#​1152)
• breaking: Remove extractor_middleware which was previously deprecated.
  Use axum::middleware::from_extractor instead (#​1077)
• breaking: Require middleware added with Handler::layer to have
  Infallible as the error type (#​1152)

Misc

• added: Support compiling to WASM. See the simple-router-wasm example
  for more details (#​1382)
• added: Add ServiceExt with methods for turning any Service into a
  MakeService similarly to Router::into_make_service (#​1302)
• added: String and binary From impls have been added to extract::ws::Message
  to be more inline with tungstenite (#​1421)
• added: Add #[derive(axum::extract::FromRef)] (#​1430)
• added: Add accept_unmasked_frames setting in WebSocketUpgrade (#​1529)
• added: Add WebSocketUpgrade::on_failed_upgrade to customize what to do
  when upgrading a connection fails (#​1539)
• fixed: Annotate panicking functions with #[track_caller] so the error
  message points to where the user added the invalid route, rather than
  somewhere internally in axum (#​1248)
• changed: axum's MSRV is now 1.60 (#​1239)
• changed: For methods that accept some S: Service, the bounds have been
  relaxed so the response type must implement IntoResponse rather than being a
  literal Response
• breaking: New tokio default feature needed for WASM support. If you
  don't need WASM support but have default_features = false for other reasons
  you likely need to re-enable the tokio feature (#​1382)
• breaking: handler::{WithState, IntoService} are merged into one type,
  named HandlerService (#​1418)